Skip to content

docs: deprecate custom session IDs in favor of metadata - #161

Merged
fukouda merged 1 commit into
mainfrom
nas/deprecate-custom-session-id
Nov 16, 2026
Merged

fukouda merged 1 commit into
mainfrom
nas/deprecate-custom-session-id

Conversation

@fukouda

@fukouda fukouda commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

The Session Lifecycle page told readers to generate their own UUID, pass it as sessionId to create, and keep using it for release, files and connect. The new session backend rejects a custom sessionId, because the ID it generates encodes where the session runs, so we are deprecating the option.

This replaces "Reserving a Session ID" with "Tying a Session to Your Own Records":

  • A deprecation callout for sessionId on create.
  • The same "write the job row first" pattern, with the reader's own ID in metadata.job_id and the returned session.id saved on the row.
  • Recovery when the process stops before it saves session.id: find the session with sessions.list({ metadata }) and release it.
  • Release, Files and connect all use the id that create returns.

bun run validate-links passes.

@vercel

vercel Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Nov 16, 2026 4:14pm UTC

Request Review

@fukouda
fukouda merged commit 608495c into main Nov 16, 2026
3 checks passed

This branch was successfully deployed

1 active deployment
Preview — 04cdb885 Deployed Nov 16, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants